AI SDK Kotlin/ai.torad.aisdk.providers

Package-level declarations

Types

typealias AlibabaCacheControl = JsonObject

@Serializable

data class AlibabaEmbeddingModelOptions(val textType: String? = null, val dimension: Int? = null, val outputType: String? = null)

Provider options for AlibabaProvider.embeddingModel — pass under the "alibaba" key in EmbeddingModelCallParams.providerOptions.

AlibabaLanguageModelOptions

@Serializable

data class AlibabaLanguageModelOptions(val enableThinking: Boolean? = null, val thinkingBudget: Int? = null, val parallelToolCalls: Boolean? = null)

AlibabaProvider

interface AlibabaProvider : Provider

AlibabaProviderOptions

typealias AlibabaProviderOptions = AlibabaLanguageModelOptions

AlibabaProviderSettings

@Serializable

data class AlibabaProviderSettings(val baseURL: String = "https://dashscope-intl.aliyuncs.com/compatible-mode/v1", val videoBaseURL: String = "https://dashscope-intl.aliyuncs.com", val embeddingBaseURL: String = "https://dashscope-intl.aliyuncs.com/api/v1", val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val includeUsage: Boolean = true)

AlibabaUsage

typealias AlibabaUsage = Usage

AlibabaVideoModelId

typealias AlibabaVideoModelId = String

AlibabaVideoModelOptions

@Serializable

data class AlibabaVideoModelOptions(val negativePrompt: String? = null, val audioUrl: String? = null, val promptExtend: Boolean? = null, val shotType: String? = null, val watermark: Boolean? = null, val audio: Boolean? = null, val referenceUrls: List<String>? = null, val pollIntervalMs: Long? = null, val pollTimeoutMs: Long? = null)

AlibabaVideoProviderOptions

typealias AlibabaVideoProviderOptions = AlibabaVideoModelOptions

AmazonBedrockEmbeddingModelOptions

typealias AmazonBedrockEmbeddingModelOptions = JsonObject

AmazonBedrockLanguageModelOptions

typealias AmazonBedrockLanguageModelOptions = JsonObject

AmazonBedrockProvider

interface AmazonBedrockProvider : Provider

AmazonBedrockProviderSettings

data class AmazonBedrockProviderSettings(val region: String? = null, val apiKey: String? = null, val accessKeyId: String? = null, val secretAccessKey: String? = null, val sessionToken: String? = null, val credentialProvider: suspend () -> BedrockCredentials? = null, val baseURL: String? = null, val agentBaseURL: String? = null, val headers: Map<String, String> = emptyMap(), val generateId: () -> String = { ai.torad.aisdk.generateId() })

AmazonBedrockRerankingModelOptions

typealias AmazonBedrockRerankingModelOptions = JsonObject

AnthropicAwsCredentials

typealias AnthropicAwsCredentials = BedrockCredentials

AnthropicAwsProvider

interface AnthropicAwsProvider : Provider

AnthropicAwsProviderSettings

@Serializable

data class AnthropicAwsProviderSettings(val region: String? = null, val workspaceId: String? = null, val apiKey: String? = null, val accessKeyId: String? = null, val secretAccessKey: String? = null, val sessionToken: String? = null, val baseURL: String? = null, val headers: Map<String, String> = emptyMap(), val credentialProvider: suspend () -> AnthropicAwsCredentials? = null, val generateId: () -> String = { ai.torad.aisdk.generateId() })

AnthropicLanguageModelOptions

typealias AnthropicLanguageModelOptions = JsonObject

AnthropicMessageMetadata

typealias AnthropicMessageMetadata = JsonObject

AnthropicMessagesLanguageModel

class AnthropicMessagesLanguageModel(client: HttpClient, settings: AnthropicProviderSettings, val modelId: String) : LanguageModel

AnthropicMessagesModelId

typealias AnthropicMessagesModelId = String

AnthropicProvider

interface AnthropicProvider : Provider

AnthropicProviderOptions

typealias AnthropicProviderOptions = AnthropicLanguageModelOptions

AnthropicProviderSettings

data class AnthropicProviderSettings(val baseURL: String = "https://api.anthropic.com/v1", val apiKey: String? = null, val authToken: String? = null, val headers: Map<String, String> = emptyMap(), val requestHeadersProvider: suspend (url: String, body: String, headers: Map<String, String>) -> Map<String, String>? = null, val buildRequestUrl: (baseURL: String, modelId: String, isStreaming: Boolean) -> String? = null, val transformRequestBody: (modelId: String, body: JsonObject, isStreaming: Boolean) -> JsonObject? = null, val supportedUrls: Map<String, List<String>>? = null, val generateId: () -> String = { ai.torad.aisdk.generateId() }, val name: String = "anthropic.messages")

AnthropicToolOptions

typealias AnthropicToolOptions = JsonObject

AnthropicTools

data class AnthropicTools(val advisor_20260301: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("advisor", "anthropic.advisor_20260301", "Consult an Anthropic advisor model during generation."), val bash_20241022: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("bash", "anthropic.bash_20241022", "Use Anthropic's hosted Bash tool."), val bash_20250124: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("bash", "anthropic.bash_20250124", "Use Anthropic's hosted Bash tool."), val codeExecution_20250522: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("code_execution", "anthropic.code_execution_20250522", "Use Anthropic hosted code execution."), val codeExecution_20250825: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("code_execution", "anthropic.code_execution_20250825", "Use Anthropic hosted code execution."), val codeExecution_20260120: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("code_execution", "anthropic.code_execution_20260120", "Use Anthropic hosted code execution."), val computer_20241022: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("computer", "anthropic.computer_20241022", "Use Anthropic computer control."), val computer_20250124: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("computer", "anthropic.computer_20250124", "Use Anthropic computer control."), val computer_20251124: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("computer", "anthropic.computer_20251124", "Use Anthropic computer control with zoom."), val memory_20250818: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("memory", "anthropic.memory_20250818", "Use Anthropic memory."), val textEditor_20241022: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("str_replace_editor", "anthropic.text_editor_20241022", "Use Anthropic text editor."), val textEditor_20250124: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("str_replace_editor", "anthropic.text_editor_20250124", "Use Anthropic text editor."), val textEditor_20250429: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("str_replace_based_edit_tool", "anthropic.text_editor_20250429", "Use Anthropic text editor."), val textEditor_20250728: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("str_replace_based_edit_tool", "anthropic.text_editor_20250728", "Use Anthropic text editor."), val webFetch_20250910: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("web_fetch", "anthropic.web_fetch_20250910", "Fetch web content through Anthropic."), val webFetch_20260209: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("web_fetch", "anthropic.web_fetch_20260209", "Fetch web content through Anthropic."), val webSearch_20250305: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("web_search", "anthropic.web_search_20250305", "Search the web through Anthropic."), val webSearch_20260209: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("web_search", "anthropic.web_search_20260209", "Search the web through Anthropic."), val toolSearchRegex_20251119: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("tool_search_tool_regex", "anthropic.tool_search_regex_20251119", "Search deferred tools with regex."), val toolSearchBm25_20251119: Tool<JsonElement, JsonElement, Any?> = anthropicProviderTool("tool_search_tool_bm25", "anthropic.tool_search_bm25_20251119", "Search deferred tools with BM25."))

AnthropicUsageIteration

typealias AnthropicUsageIteration = JsonObject

AssemblyAICustomSpelling

@Serializable

data class AssemblyAICustomSpelling(val from: List<String>, val to: String)

AssemblyAIProvider

interface AssemblyAIProvider : Provider

AssemblyAIProviderSettings

@Serializable

data class AssemblyAIProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val pollingIntervalMillis: Long)

AssemblyAITranscriptionModelId

typealias AssemblyAITranscriptionModelId = String

AssemblyAITranscriptionModelOptions

@Serializable

data class AssemblyAITranscriptionModelOptions(val audioEndAt: Int? = null, val audioStartFrom: Int? = null, val autoChapters: Boolean? = null, val autoHighlights: Boolean? = null, val boostParam: String? = null, val contentSafety: Boolean? = null, val contentSafetyConfidence: Int? = null, val customSpelling: List<AssemblyAICustomSpelling>? = null, val disfluencies: Boolean? = null, val entityDetection: Boolean? = null, val filterProfanity: Boolean? = null, val formatText: Boolean? = null, val iabCategories: Boolean? = null, val languageCode: String? = null, val languageConfidenceThreshold: Float? = null, val languageDetection: Boolean? = null, val multichannel: Boolean? = null, val punctuate: Boolean? = null, val redactPii: Boolean? = null, val redactPiiAudio: Boolean? = null, val redactPiiAudioQuality: String? = null, val redactPiiPolicies: List<String>? = null, val redactPiiSub: String? = null, val sentimentAnalysis: Boolean? = null, val speakerLabels: Boolean? = null, val speakersExpected: Int? = null, val speechThreshold: Float? = null, val summarization: Boolean? = null, val summaryModel: String? = null, val summaryType: String? = null, val webhookAuthHeaderName: String? = null, val webhookAuthHeaderValue: String? = null, val webhookUrl: String? = null, val wordBoost: List<String>? = null)

AzureOpenAIChatModelId

typealias AzureOpenAIChatModelId = String

AzureOpenAICompletionModelId

typealias AzureOpenAICompletionModelId = String

AzureOpenAIEmbeddingModelId

typealias AzureOpenAIEmbeddingModelId = String

AzureOpenAIImageModelId

typealias AzureOpenAIImageModelId = String

AzureOpenAIProvider

interface AzureOpenAIProvider : Provider

AzureOpenAIProviderSettings

data class AzureOpenAIProviderSettings(val resourceName: String? = null, val baseURL: String? = null, val apiKey: String? = null, val tokenProvider: suspend () -> String? = null, val headers: Map<String, String> = emptyMap(), val apiVersion: String = "v1", val useDeploymentBasedUrls: Boolean = false)

AzureOpenAISpeechModelId

typealias AzureOpenAISpeechModelId = String

AzureOpenAITools

data class AzureOpenAITools(val codeInterpreter: Tool<JsonElement, JsonElement, Any?> = OpenAITools().codeInterpreter, val fileSearch: Tool<JsonElement, JsonElement, Any?> = OpenAITools().fileSearch, val imageGeneration: Tool<JsonElement, JsonElement, Any?> = OpenAITools().imageGeneration, val webSearch: Tool<JsonElement, JsonElement, Any?> = OpenAITools().webSearch, val webSearchPreview: Tool<JsonElement, JsonElement, Any?> = OpenAITools().webSearchPreview)

AzureOpenAITranscriptionModelId

typealias AzureOpenAITranscriptionModelId = String

BasetenChatModelId

typealias BasetenChatModelId = String

BasetenEmbeddingModelId

typealias BasetenEmbeddingModelId = String

BasetenEmbeddingModelOptions

@Serializable

data class BasetenEmbeddingModelOptions(val raw: Map<String, JsonElement> = emptyMap())

BasetenErrorData

@Serializable

data class BasetenErrorData(val error: String)

BasetenProvider

interface BasetenProvider : Provider

BasetenProviderSettings

@Serializable

data class BasetenProviderSettings(val apiKey: String? = null, val baseURL: String = "https://inference.baseten.co/v1", val modelURL: String? = null, val headers: Map<String, String> = emptyMap())

BedrockAnthropicModelId

typealias BedrockAnthropicModelId = String

BedrockAnthropicProvider

interface BedrockAnthropicProvider : Provider

BedrockAnthropicProviderSettings

typealias BedrockAnthropicProviderSettings = AmazonBedrockProviderSettings

BedrockChatModelId

typealias BedrockChatModelId = String

BedrockCredentials

@Serializable

data class BedrockCredentials(val accessKeyId: String, val secretAccessKey: String, val sessionToken: String? = null, val region: String? = null)

BedrockEmbeddingModelId

typealias BedrockEmbeddingModelId = String

BedrockImageModelId

typealias BedrockImageModelId = String

BedrockMantleChatModelId

typealias BedrockMantleChatModelId = String

BedrockMantleModelId

typealias BedrockMantleModelId = String

BedrockMantleProvider

interface BedrockMantleProvider : Provider

BedrockMantleProviderSettings

typealias BedrockMantleProviderSettings = AmazonBedrockProviderSettings

BedrockMantleResponsesModelId

typealias BedrockMantleResponsesModelId = String

BedrockProviderOptions

typealias BedrockProviderOptions = JsonObject

BedrockRerankingModelId

typealias BedrockRerankingModelId = String

BedrockRerankingOptions

typealias BedrockRerankingOptions = JsonObject

BlackForestLabsAspectRatio

typealias BlackForestLabsAspectRatio = String

BlackForestLabsImageModelId

typealias BlackForestLabsImageModelId = String

BlackForestLabsImageModelOptions

@Serializable

data class BlackForestLabsImageModelOptions(val imagePrompt: String? = null, val imagePromptStrength: Double? = null, val inputImage: String? = null, val inputImage2: String? = null, val inputImage3: String? = null, val inputImage4: String? = null, val inputImage5: String? = null, val inputImage6: String? = null, val inputImage7: String? = null, val inputImage8: String? = null, val inputImage9: String? = null, val inputImage10: String? = null, val steps: Int? = null, val guidance: Double? = null, val width: Int? = null, val height: Int? = null, val outputFormat: String? = null, val promptUpsampling: Boolean? = null, val raw: Boolean? = null, val safetyTolerance: Int? = null, val webhookSecret: String? = null, val webhookUrl: String? = null, val pollIntervalMillis: Long? = null, val pollTimeoutMillis: Long? = null)

BlackForestLabsImageProviderOptions

typealias BlackForestLabsImageProviderOptions = BlackForestLabsImageModelOptions

BlackForestLabsProvider

interface BlackForestLabsProvider : Provider

BlackForestLabsProviderSettings

@Serializable

data class BlackForestLabsProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.bfl.ai/v1", val headers: Map<String, String> = emptyMap(), val pollIntervalMillis: Long? = null, val pollTimeoutMillis: Long? = null)

ByteDanceProvider

interface ByteDanceProvider : Provider

ByteDanceProviderSettings

@Serializable

data class ByteDanceProviderSettings(val apiKey: String? = null, val baseURL: String = "https://ark.ap-southeast.bytepluses.com/api/v3", val headers: Map<String, String> = emptyMap())

ByteDanceVideoModelId

typealias ByteDanceVideoModelId = String

ByteDanceVideoProviderOptions

@Serializable

data class ByteDanceVideoProviderOptions(val watermark: Boolean? = null, val generateAudio: Boolean? = null, val cameraFixed: Boolean? = null, val returnLastFrame: Boolean? = null, val serviceTier: String? = null, val draft: Boolean? = null, val lastFrameImage: String? = null, val referenceImages: List<String>? = null, val referenceVideos: List<String>? = null, val referenceAudio: List<String>? = null, val pollIntervalMs: Long? = null, val pollTimeoutMs: Long? = null)

CerebrasErrorData

@Serializable

data class CerebrasErrorData(val message: String, val type: String? = null, val param: String? = null, val code: String? = null)

CerebrasProvider

interface CerebrasProvider : Provider

CerebrasProviderSettings

@Serializable

data class CerebrasProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.cerebras.ai/v1", val headers: Map<String, String> = emptyMap())

CohereChatModelId

typealias CohereChatModelId = String

CohereChatModelOptions

typealias CohereChatModelOptions = CohereLanguageModelOptions

CohereEmbeddingModelId

typealias CohereEmbeddingModelId = String

CohereEmbeddingModelOptions

@Serializable

data class CohereEmbeddingModelOptions(val inputType: String? = null, val truncate: String? = null, val outputDimension: Int? = null)

CohereLanguageModelOptions

@Serializable

data class CohereLanguageModelOptions(val thinking: CohereThinkingOptions? = null)

CohereProvider

interface CohereProvider : Provider

CohereProviderSettings

@Serializable

data class CohereProviderSettings(val baseURL: String = "https://api.cohere.com/v2", val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

CohereRerankingModelId

typealias CohereRerankingModelId = String

CohereRerankingModelOptions

@Serializable

data class CohereRerankingModelOptions(val maxTokensPerDoc: Int? = null, val priority: Int? = null)

CohereRerankingOptions

typealias CohereRerankingOptions = CohereRerankingModelOptions

CohereThinkingOptions

@Serializable

data class CohereThinkingOptions(val type: String? = null, val tokenBudget: Int? = null)

DeepgramProvider

interface DeepgramProvider : Provider

DeepgramProviderSettings

@Serializable

data class DeepgramProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

DeepgramSpeechCallOptions

typealias DeepgramSpeechCallOptions = DeepgramSpeechModelOptions

DeepgramSpeechModel

class DeepgramSpeechModel(client: HttpClient, settings: DeepgramProviderSettings, val modelId: String) : SpeechModel

DeepgramSpeechModelId

typealias DeepgramSpeechModelId = String

DeepgramSpeechModelOptions

@Serializable

data class DeepgramSpeechModelOptions(val bitRate: JsonElement? = null, val container: String? = null, val encoding: String? = null, val sampleRate: Int? = null, val callback: String? = null, val callbackMethod: String? = null, val mipOptOut: Boolean? = null, val tag: JsonElement? = null)

DeepgramTranscriptionModelId

typealias DeepgramTranscriptionModelId = String

DeepgramTranscriptionModelOptions

@Serializable

data class DeepgramTranscriptionModelOptions(val language: String? = null, val detectLanguage: Boolean? = null, val smartFormat: Boolean? = null, val punctuate: Boolean? = null, val paragraphs: Boolean? = null, val summarize: JsonElement? = null, val topics: Boolean? = null, val intents: Boolean? = null, val sentiment: Boolean? = null, val detectEntities: Boolean? = null, val redact: JsonElement? = null, val replace: String? = null, val search: String? = null, val keyterm: String? = null, val diarize: Boolean? = null, val utterances: Boolean? = null, val uttSplit: Float? = null, val fillerWords: Boolean? = null)

DeepInfraChatModelId

typealias DeepInfraChatModelId = String

DeepInfraCompletionModelId

typealias DeepInfraCompletionModelId = String

DeepInfraEmbeddingModelId

typealias DeepInfraEmbeddingModelId = String

DeepInfraErrorData

typealias DeepInfraErrorData = JsonElement

DeepInfraImageModelId

typealias DeepInfraImageModelId = String

DeepInfraProvider

interface DeepInfraProvider : Provider

DeepInfraProviderSettings

@Serializable

data class DeepInfraProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.deepinfra.com/v1", val headers: Map<String, String> = emptyMap())

DeepSeekChatOptions

typealias DeepSeekChatOptions = DeepSeekLanguageModelOptions

DeepSeekErrorData

typealias DeepSeekErrorData = JsonElement

DeepSeekLanguageModelOptions

@Serializable

data class DeepSeekLanguageModelOptions(val raw: Map<String, JsonElement> = emptyMap())

DeepSeekProvider

interface DeepSeekProvider : Provider

DeepSeekProviderSettings

@Serializable

data class DeepSeekProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.deepseek.com", val headers: Map<String, String> = emptyMap())

ElevenLabsProvider

interface ElevenLabsProvider : Provider

ElevenLabsProviderSettings

@Serializable

data class ElevenLabsProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

ElevenLabsSpeechModelId

typealias ElevenLabsSpeechModelId = String

ElevenLabsSpeechModelOptions

@Serializable

data class ElevenLabsSpeechModelOptions(val languageCode: String? = null, val voiceSettings: JsonObject? = null, val pronunciationDictionaryLocators: List<JsonObject>? = null, val seed: Int? = null, val previousText: String? = null, val nextText: String? = null, val previousRequestIds: List<String>? = null, val nextRequestIds: List<String>? = null, val applyTextNormalization: String? = null, val applyLanguageTextNormalization: Boolean? = null, val enableLogging: Boolean? = null)

ElevenLabsSpeechVoiceId

typealias ElevenLabsSpeechVoiceId = String

ElevenLabsTranscriptionModelId

typealias ElevenLabsTranscriptionModelId = String

ElevenLabsTranscriptionModelOptions

@Serializable

data class ElevenLabsTranscriptionModelOptions(val languageCode: String? = null, val tagAudioEvents: Boolean? = null, val numSpeakers: Int? = null, val timestampsGranularity: String? = null, val diarize: Boolean? = null, val fileFormat: String? = null)

FalErrorData

typealias FalErrorData = JsonObject

FalImageModelId

typealias FalImageModelId = String

FalImageModelOptions

@Serializable

data class FalImageModelOptions(val useMultipleImages: Boolean? = null)

FalImageProviderOptions

typealias FalImageProviderOptions = FalImageModelOptions

FalProvider

interface FalProvider : Provider

FalProviderSettings

@Serializable

data class FalProviderSettings(val apiKey: String? = null, val baseURL: String = "https://fal.run", val headers: Map<String, String> = emptyMap(), val transcriptionPollIntervalMillis: Long, val transcriptionMaxPollAttempts: Int = 60, val videoPollIntervalMillis: Long, val videoMaxPollAttempts: Int = 150)

FalSpeechModelId

typealias FalSpeechModelId = String

FalSpeechModelOptions

@Serializable

data class FalSpeechModelOptions(val voice_setting: JsonObject? = null, val audio_setting: JsonObject? = null, val language_boost: String? = null, val pronunciation_dict: JsonObject? = null)

FalTranscriptionModelId

typealias FalTranscriptionModelId = String

FalTranscriptionModelOptions

@Serializable

data class FalTranscriptionModelOptions(val language: String? = "en", val diarize: Boolean? = true, val chunkLevel: String? = "segment", val version: String? = "3", val batchSize: Int? = 64, val numSpeakers: Int? = null)

FalVideoModelId

typealias FalVideoModelId = String

FalVideoModelOptions

@Serializable

data class FalVideoModelOptions(val loop: Boolean? = null, val motionStrength: Float? = null, val pollIntervalMs: Long? = null, val pollTimeoutMs: Long? = null, val resolution: String? = null, val negativePrompt: String? = null, val promptOptimizer: Boolean? = null)

FalVideoProviderOptions

typealias FalVideoProviderOptions = FalVideoModelOptions

FireworksChatModelId

typealias FireworksChatModelId = String

FireworksCompletionModelId

typealias FireworksCompletionModelId = String

FireworksEmbeddingModelId

typealias FireworksEmbeddingModelId = String

FireworksEmbeddingModelOptions

@Serializable

data class FireworksEmbeddingModelOptions(val raw: Map<String, JsonElement> = emptyMap())

FireworksEmbeddingProviderOptions

typealias FireworksEmbeddingProviderOptions = FireworksEmbeddingModelOptions

FireworksErrorData

@Serializable

data class FireworksErrorData(val error: String)

FireworksImageModel

class FireworksImageModel(client: HttpClient, settings: FireworksProviderSettings, val modelId: FireworksImageModelId) : ImageModel

FireworksImageModelId

typealias FireworksImageModelId = String

FireworksLanguageModelOptions

@Serializable

data class FireworksLanguageModelOptions(val thinking: FireworksThinkingOptions? = null, val reasoningHistory: String? = null, val raw: Map<String, JsonElement> = emptyMap())

FireworksProvider

interface FireworksProvider : Provider

FireworksProviderOptions

typealias FireworksProviderOptions = FireworksLanguageModelOptions

FireworksProviderSettings

@Serializable

data class FireworksProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.fireworks.ai/inference/v1", val headers: Map<String, String> = emptyMap())

FireworksThinkingOptions

@Serializable

data class FireworksThinkingOptions(val type: String? = null, val budgetTokens: Int? = null)

GladiaProvider

interface GladiaProvider : Provider

GladiaProviderSettings

@Serializable

data class GladiaProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val pollingIntervalMillis: Long, val maxPollAttempts: Int = 60)

GladiaTranscriptionModelId

typealias GladiaTranscriptionModelId = String

GladiaTranscriptionModelOptions

@Serializable

data class GladiaTranscriptionModelOptions(val contextPrompt: String? = null, val customVocabulary: JsonElement? = null, val customVocabularyConfig: JsonObject? = null, val detectLanguage: Boolean? = null, val enableCodeSwitching: Boolean? = null, val codeSwitchingConfig: JsonObject? = null, val language: String? = null, val callback: Boolean? = null, val callbackConfig: JsonObject? = null, val subtitles: Boolean? = null, val subtitlesConfig: JsonObject? = null, val diarization: Boolean? = null, val diarizationConfig: JsonObject? = null, val translation: Boolean? = null, val translationConfig: JsonObject? = null, val summarization: Boolean? = null, val summarizationConfig: JsonObject? = null, val moderation: Boolean? = null, val namedEntityRecognition: Boolean? = null, val chapterization: Boolean? = null, val nameConsistency: Boolean? = null, val customSpelling: Boolean? = null, val customSpellingConfig: JsonObject? = null, val structuredDataExtraction: Boolean? = null, val structuredDataExtractionConfig: JsonObject? = null, val sentimentAnalysis: Boolean? = null, val audioToLlm: Boolean? = null, val audioToLlmConfig: JsonObject? = null, val customMetadata: JsonObject? = null, val sentences: Boolean? = null, val displayMode: Boolean? = null, val punctuationEnhanced: Boolean? = null)

GoogleEmbeddingModelOptions

typealias GoogleEmbeddingModelOptions = JsonObject

GoogleErrorData

typealias GoogleErrorData = JsonObject

GoogleGenerativeAIEmbeddingModelId

typealias GoogleGenerativeAIEmbeddingModelId = String

GoogleGenerativeAIEmbeddingProviderOptions

typealias GoogleGenerativeAIEmbeddingProviderOptions = JsonObject

GoogleGenerativeAIImageModelId

typealias GoogleGenerativeAIImageModelId = String

GoogleGenerativeAIImageProviderOptions

typealias GoogleGenerativeAIImageProviderOptions = JsonObject

GoogleGenerativeAIModelId

typealias GoogleGenerativeAIModelId = String

GoogleGenerativeAIProvider

interface GoogleGenerativeAIProvider : Provider

GoogleGenerativeAIProviderMetadata

typealias GoogleGenerativeAIProviderMetadata = JsonObject

GoogleGenerativeAIProviderOptions

typealias GoogleGenerativeAIProviderOptions = JsonObject

GoogleGenerativeAIProviderSettings

@Serializable

data class GoogleGenerativeAIProviderSettings(val baseURL: String = "https://generativelanguage.googleapis.com/v1beta", val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val generateId: () -> String = { ai.torad.aisdk.generateId() }, val name: String = "google.generative-ai", val videoPollIntervalMillis: Long, val videoMaxPollAttempts: Int = 120)

GoogleGenerativeAIVideoModelId

typealias GoogleGenerativeAIVideoModelId = String

GoogleGenerativeAIVideoProviderOptions

typealias GoogleGenerativeAIVideoProviderOptions = JsonObject

GoogleImageModelOptions

typealias GoogleImageModelOptions = JsonObject

GoogleInteractionsAgentName

typealias GoogleInteractionsAgentName = String

GoogleInteractionsModelId

typealias GoogleInteractionsModelId = String

GoogleInteractionsModelInput

sealed interface GoogleInteractionsModelInput

GoogleInteractionsProviderMetadata

typealias GoogleInteractionsProviderMetadata = JsonObject

GoogleLanguageModelInteractionsOptions

typealias GoogleLanguageModelInteractionsOptions = JsonObject

GoogleLanguageModelOptions

typealias GoogleLanguageModelOptions = JsonObject

GoogleTools

data class GoogleTools(val googleSearch: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("google_search", "google.google_search", "Ground responses with Google Search."), val enterpriseWebSearch: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("enterprise_web_search", "google.enterprise_web_search", "Ground responses with Enterprise Web Search."), val googleMaps: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("google_maps", "google.google_maps", "Ground responses with Google Maps."), val urlContext: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("url_context", "google.url_context", "Fetch URL context through Google."), val fileSearch: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("file_search", "google.file_search", "Use Gemini File Search."), val codeExecution: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("code_execution", "google.code_execution", "Use Google hosted code execution."), val vertexRagStore: Tool<JsonElement, JsonElement, Any?> = googleProviderTool("vertex_rag_store", "google.vertex_rag_store", "Use Vertex RAG Store."))

GoogleVertexAnthropicProvider

interface GoogleVertexAnthropicProvider : Provider

GoogleVertexAnthropicProviderSettings

typealias GoogleVertexAnthropicProviderSettings = GoogleVertexProviderSettings

GoogleVertexEmbeddingModelOptions

typealias GoogleVertexEmbeddingModelOptions = JsonObject

GoogleVertexImageModelOptions

typealias GoogleVertexImageModelOptions = JsonObject

GoogleVertexImageProviderOptions

typealias GoogleVertexImageProviderOptions = JsonObject

GoogleVertexMaasModelId

typealias GoogleVertexMaasModelId = String

GoogleVertexMaasProvider

interface GoogleVertexMaasProvider : Provider

GoogleVertexMaasProviderSettings

typealias GoogleVertexMaasProviderSettings = GoogleVertexProviderSettings

GoogleVertexProvider

interface GoogleVertexProvider : Provider

GoogleVertexProviderSettings

@Serializable

data class GoogleVertexProviderSettings(val project: String? = null, val location: String = "us-central1", val baseURL: String? = null, val accessToken: String? = null, val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val generateId: () -> String = { ai.torad.aisdk.generateId() })

GoogleVertexVideoModelId

typealias GoogleVertexVideoModelId = String

GoogleVertexVideoModelOptions

typealias GoogleVertexVideoModelOptions = JsonObject

GoogleVertexVideoProviderOptions

typealias GoogleVertexVideoProviderOptions = JsonObject

GoogleVertexXaiModelId

typealias GoogleVertexXaiModelId = String

GoogleVertexXaiProvider

interface GoogleVertexXaiProvider : Provider

GoogleVertexXaiProviderSettings

typealias GoogleVertexXaiProviderSettings = GoogleVertexProviderSettings

GoogleVideoModelOptions

typealias GoogleVideoModelOptions = JsonObject

GroqLanguageModelOptions

@Serializable

data class GroqLanguageModelOptions(val raw: Map<String, JsonElement> = emptyMap())

GroqProvider

interface GroqProvider : Provider

GroqProviderOptions

typealias GroqProviderOptions = GroqLanguageModelOptions

GroqProviderSettings

@Serializable

data class GroqProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.groq.com/openai/v1", val headers: Map<String, String> = emptyMap())

GroqTools

data class GroqTools(val browserSearch: Tool<JsonElement, JsonElement, Any?> = groqBrowserSearchTool)

GroqTranscriptionModelOptions

@Serializable

data class GroqTranscriptionModelOptions(val language: String? = null, val prompt: String? = null, val temperature: Float? = null, val responseFormat: String? = null)

GroundingMetadataSchema

typealias GroundingMetadataSchema = JsonObject

HuggingFaceErrorData

typealias HuggingFaceErrorData = JsonObject

HuggingFaceProvider

interface HuggingFaceProvider : Provider

HuggingFaceProviderSettings

data class HuggingFaceProviderSettings(val apiKey: String? = null, val baseURL: String = "https://router.huggingface.co/v1", val headers: Map<String, String> = emptyMap(), val generateId: () -> String = { ai.torad.aisdk.generateId() })

HuggingFaceResponsesModelId

typealias HuggingFaceResponsesModelId = String

HuggingFaceResponsesSettings

@Serializable

data class HuggingFaceResponsesSettings(val metadata: Map<String, String>? = null, val instructions: String? = null, val strictJsonSchema: Boolean? = null, val reasoningEffort: String? = null)

HumeProvider

interface HumeProvider : Provider

HumeProviderSettings

@Serializable

data class HumeProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

HumeSpeechModelOptions

@Serializable

data class HumeSpeechModelOptions(val context: JsonObject? = null)

KlingAIProvider

interface KlingAIProvider : Provider

KlingAIProviderSettings

@Serializable

data class KlingAIProviderSettings(val accessKey: String? = null, val secretKey: String? = null, val baseURL: String = "https://api-singapore.klingai.com", val headers: Map<String, String> = emptyMap())

KlingAIVideoModelId

typealias KlingAIVideoModelId = String

KlingAIVideoModelOptions

@Serializable

data class KlingAIVideoModelOptions(val mode: String? = null, val pollIntervalMs: Long? = null, val pollTimeoutMs: Long? = null, val negativePrompt: String? = null, val sound: String? = null, val cfgScale: Float? = null, val cameraControl: JsonObject? = null, val imageTail: String? = null, val staticMask: String? = null, val dynamicMasks: JsonArray? = null, val multiShot: Boolean? = null, val shotType: String? = null, val multiPrompt: JsonArray? = null, val elementList: JsonArray? = null, val voiceList: JsonArray? = null, val watermarkEnabled: Boolean? = null, val videoUrl: String? = null, val characterOrientation: String? = null, val keepOriginalSound: String? = null)

KlingAIVideoProviderOptions

typealias KlingAIVideoProviderOptions = KlingAIVideoModelOptions

LMNTProvider

interface LMNTProvider : Provider

LMNTProviderSettings

@Serializable

data class LMNTProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

LMNTSpeechModelId

typealias LMNTSpeechModelId = String

LMNTSpeechModelOptions

@Serializable

data class LMNTSpeechModelOptions(val model: String? = null, val format: String? = null, val sampleRate: Int? = null, val speed: Float? = null, val seed: Int? = null, val conversational: Boolean? = null, val length: Float? = null, val topP: Float? = null, val temperature: Float? = null)

LumaImageModelId

typealias LumaImageModelId = String

LumaImageModelOptions

@Serializable

data class LumaImageModelOptions(val referenceType: String? = null, val images: JsonArray? = null, val pollIntervalMillis: Long? = null, val maxPollAttempts: Int? = null)

LumaImageProviderOptions

typealias LumaImageProviderOptions = LumaImageModelOptions

LumaProvider

interface LumaProvider : Provider

LumaProviderSettings

@Serializable

data class LumaProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.lumalabs.ai", val headers: Map<String, String> = emptyMap())

MistralChatModelId

typealias MistralChatModelId = String

MistralEmbeddingModelId

typealias MistralEmbeddingModelId = String

MistralLanguageModelOptions

@Serializable

data class MistralLanguageModelOptions(val safePrompt: Boolean? = null, val documentImageLimit: Int? = null, val documentPageLimit: Int? = null, val structuredOutputs: Boolean? = null, val strictJsonSchema: Boolean? = null, val parallelToolCalls: Boolean? = null, val reasoningEffort: String? = null)

MistralProvider

interface MistralProvider : Provider

MistralProviderOptions

typealias MistralProviderOptions = MistralLanguageModelOptions

MistralProviderSettings

@Serializable

data class MistralProviderSettings(val baseURL: String = "https://api.mistral.ai/v1", val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

MockEmbeddingModel

class MockEmbeddingModel(val modelId: String = "mock/embedding", val provider: String = "mock", dimensions: Int = 3) : EmbeddingModel

MockImageModel

class MockImageModel(val modelId: String = "mock/image", val provider: String = "mock", image: GeneratedFile = GeneratedFile("image/png", "iVBORw0KGgo=", "image.png")) : ImageModel

MockLanguageModel

class MockLanguageModel(val modelId: String = "mock/test", val provider: String = "mock", responses: List<ScriptedResponse>) : LanguageModel

Test stub for a LanguageModel. Drives the agent loop deterministically by replaying a list of ScriptedResponses — one per stream call.

MockRerankingModel

class MockRerankingModel(val modelId: String = "mock/rerank", val provider: String = "mock") : RerankingModel

MockSpeechModel

class MockSpeechModel(val modelId: String = "mock/speech", val provider: String = "mock", audio: GeneratedFile = GeneratedFile("audio/mpeg", "SUQz", "speech.mp3")) : SpeechModel

MockTranscriptionModel

class MockTranscriptionModel(val modelId: String = "mock/transcription", val provider: String = "mock", transcript: String = "hello world") : TranscriptionModel

MockVideoModel

class MockVideoModel(val modelId: String = "mock/video", val provider: String = "mock", video: GeneratedFile = GeneratedFile("video/mp4", "AAAA", "video.mp4")) : VideoModel

MoonshotAIChatModelId

typealias MoonshotAIChatModelId = String

MoonshotAILanguageModelOptions

@Serializable

data class MoonshotAILanguageModelOptions(val raw: Map<String, JsonElement> = emptyMap())

MoonshotAIProvider

interface MoonshotAIProvider : Provider

MoonshotAIProviderOptions

typealias MoonshotAIProviderOptions = MoonshotAILanguageModelOptions

MoonshotAIProviderSettings

@Serializable

data class MoonshotAIProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.moonshot.ai/v1", val headers: Map<String, String> = emptyMap())

OpenAICompatibleProvider

interface OpenAICompatibleProvider : Provider

OpenAICompatibleProviderSettings

data class OpenAICompatibleProviderSettings(val name: String, val baseUrl: String, val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val queryParams: Map<String, String> = emptyMap(), val includeUsage: Boolean = false, val supportsStructuredOutputs: Boolean = false, val supportedUrls: Map<String, List<String>> = emptyMap(), val maxEmbeddingsPerCall: Int = 2048, val authHeadersProvider: suspend () -> Map<String, String>? = null, val urlBuilder: (path: String, modelId: String) -> String? = null, val userAgentSuffix: String? = "ai-sdk/openai-compatible-kotlin", val providerOptionsName: String? = null, val chatMaxOutputTokensKey: String = "max_tokens", val chatSeedKey: String = "seed", val transformChatRequestBody: (JsonObject) -> JsonObject? = null, val convertUsage: (JsonElement?) -> Usage? = null, val transformChatResponse: (JsonObject) -> JsonObject? = null)

OpenAIProvider

interface OpenAIProvider : Provider

OpenAIProviderNotConfiguredError

class OpenAIProviderNotConfiguredError : AiSdkException

OpenAIProviderSettings

data class OpenAIProviderSettings(val baseURL: String = "https://api.openai.com/v1", val apiKey: String? = null, val organization: String? = null, val project: String? = null, val headers: Map<String, String> = emptyMap(), val name: String = "openai", val queryParams: Map<String, String> = emptyMap(), val includeUsage: Boolean = false)

OpenAITools

data class OpenAITools(val applyPatch: Tool<JsonElement, JsonElement, Any?> = openAIApplyPatch(), val codeInterpreter: Tool<JsonElement, JsonElement, Any?> = openAICodeInterpreter(), val fileSearch: Tool<JsonElement, JsonElement, Any?> = openAIFileSearch(JsonObject(emptyMap())), val imageGeneration: Tool<JsonElement, JsonElement, Any?> = openAIImageGeneration(), val localShell: Tool<JsonElement, JsonElement, Any?> = openAILocalShell(), val shell: Tool<JsonElement, JsonElement, Any?> = openAIShell(), val webSearchPreview: Tool<JsonElement, JsonElement, Any?> = openAIWebSearchPreview(), val webSearch: Tool<JsonElement, JsonElement, Any?> = openAIWebSearch(), val mcp: Tool<JsonElement, JsonElement, Any?> = openAIMcp(), val toolSearch: Tool<JsonElement, JsonElement, Any?> = openAIToolSearch())

OpenResponsesAllowedTools

@Serializable

data class OpenResponsesAllowedTools(val toolNames: List<String> = emptyList(), val mode: String? = null)

OpenResponsesOptions

@Serializable

data class OpenResponsesOptions(val conversation: String? = null, val include: List<String>? = null, val instructions: String? = null, val logprobs: JsonElement? = null, val maxToolCalls: Int? = null, val metadata: JsonElement? = null, val parallelToolCalls: Boolean? = null, val previousResponseId: String? = null, val promptCacheKey: String? = null, val promptCacheRetention: String? = null, val reasoningEffort: String? = null, val reasoningSummary: String? = null, val safetyIdentifier: String? = null, val serviceTier: String? = null, val store: Boolean? = null, val passThroughUnsupportedFiles: Boolean? = null, val strictJsonSchema: Boolean? = null, val textVerbosity: String? = null, val truncation: String? = null, val user: String? = null, val systemMessageMode: String? = null, val forceReasoning: Boolean? = null, val allowedTools: OpenResponsesAllowedTools? = null)

OpenResponsesProvider

interface OpenResponsesProvider : Provider

OpenResponsesProviderSettings

data class OpenResponsesProviderSettings(val url: String, val name: String, val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val authHeadersProvider: suspend () -> Map<String, String>? = null, val userAgentSuffix: String? = "ai-sdk/open-responses/", val providerOptionsName: String? = null, val supportedUrls: Map<String, List<String>> = OPEN_RESPONSES_SUPPORTED_URLS, val fileIdPrefixes: List<String> = emptyList())

PerplexityProvider

interface PerplexityProvider : Provider

PerplexityProviderSettings

@Serializable

data class PerplexityProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.perplexity.ai", val headers: Map<String, String> = emptyMap())

ProdiaImageModelId

typealias ProdiaImageModelId = String

ProdiaImageModelOptions

@Serializable

data class ProdiaImageModelOptions(val steps: Int? = null, val width: Int? = null, val height: Int? = null, val stylePreset: String? = null, val loras: List<String>? = null, val progressive: Boolean? = null)

ProdiaImageProviderOptions

typealias ProdiaImageProviderOptions = ProdiaImageModelOptions

ProdiaLanguageModelId

typealias ProdiaLanguageModelId = String

ProdiaLanguageModelOptions

@Serializable

data class ProdiaLanguageModelOptions(val aspectRatio: String? = null)

ProdiaProvider

interface ProdiaProvider : Provider

ProdiaProviderSettings

@Serializable

data class ProdiaProviderSettings(val apiKey: String? = null, val baseURL: String = "https://inference.prodia.com/v2", val headers: Map<String, String> = emptyMap())

ProdiaVideoModelId

typealias ProdiaVideoModelId = String

ProdiaVideoModelOptions

@Serializable

data class ProdiaVideoModelOptions(val resolution: String? = null)

PromptFeedbackSchema

typealias PromptFeedbackSchema = JsonObject

QuiverAIImageModelId

typealias QuiverAIImageModelId = String

QuiverAIImageModelOptions

@Serializable

data class QuiverAIImageModelOptions(val operation: String? = null, val instructions: String? = null, val temperature: Double? = null, val topP: Double? = null, val presencePenalty: Double? = null, val maxOutputTokens: Int? = null, val autoCrop: Boolean? = null, val targetSize: Int? = null)

QuiverAIOperation

typealias QuiverAIOperation = String

QuiverAIProvider

interface QuiverAIProvider : Provider

QuiverAIProviderSettings

@Serializable

data class QuiverAIProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.quiver.ai/v1", val headers: Map<String, String> = emptyMap())

ReplicateImageModelId

typealias ReplicateImageModelId = String

ReplicateImageModelOptions

@Serializable

data class ReplicateImageModelOptions(val maxWaitTimeInSeconds: Double? = null, val guidance_scale: Double? = null, val num_inference_steps: Double? = null, val negative_prompt: String? = null, val output_format: String? = null, val output_quality: Int? = null, val strength: Double? = null)

ReplicateImageProviderOptions

typealias ReplicateImageProviderOptions = ReplicateImageModelOptions

ReplicateProvider

interface ReplicateProvider : Provider

ReplicateProviderSettings

@Serializable

data class ReplicateProviderSettings(val apiToken: String? = null, val baseURL: String = "https://api.replicate.com/v1", val headers: Map<String, String> = emptyMap())

ReplicateVideoModelId

typealias ReplicateVideoModelId = String

ReplicateVideoModelOptions

@Serializable

data class ReplicateVideoModelOptions(val pollIntervalMs: Long? = null, val pollTimeoutMs: Long? = null, val maxWaitTimeInSeconds: Double? = null, val guidance_scale: Double? = null, val num_inference_steps: Double? = null, val motion_bucket_id: Double? = null, val cond_aug: Double? = null, val decoding_t: Double? = null, val video_length: String? = null, val sizing_strategy: String? = null, val frames_per_second: Double? = null, val prompt_optimizer: Boolean? = null)

ReplicateVideoProviderOptions

typealias ReplicateVideoProviderOptions = ReplicateVideoModelOptions

RevaiProvider

interface RevaiProvider : Provider

RevaiProviderSettings

@Serializable

data class RevaiProviderSettings(val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val pollingIntervalMillis: Long, val maxPollAttempts: Int = 60)

RevaiTranscriptionModelId

typealias RevaiTranscriptionModelId = String

RevaiTranscriptionModelOptions

@Serializable

data class RevaiTranscriptionModelOptions(val metadata: String? = null, val notification_config: JsonObject? = null, val delete_after_seconds: Int? = null, val verbatim: Boolean? = null, val rush: Boolean? = null, val test_mode: Boolean? = null, val segments_to_transcribe: JsonElement? = null, val speaker_names: JsonElement? = null, val skip_diarization: Boolean? = null, val skip_postprocessing: Boolean? = null, val skip_punctuation: Boolean? = null, val remove_disfluencies: Boolean? = null, val remove_atmospherics: Boolean? = null, val filter_profanity: Boolean? = null, val speaker_channels_count: Int? = null, val speakers_count: Int? = null, val diarization_type: String? = null, val custom_vocabulary_id: String? = null, val custom_vocabularies: JsonElement? = null, val strict_custom_vocabulary: Boolean? = null, val summarization_config: JsonObject? = null, val translation_config: JsonObject? = null, val language: String? = null, val forced_alignment: Boolean? = null)

SafetyRatingSchema

typealias SafetyRatingSchema = JsonObject

ScriptedResponse

data class ScriptedResponse(val events: List<StreamEvent>, val finishReason: FinishReason = FinishReason.Stop, val usage: Usage = Usage(promptTokens = 1, completionTokens = 1), val providerMetadata: Map<String, JsonElement> = emptyMap(), val rawFinishReason: String? = null, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

One scripted response — what a single stream call should emit.

TogetherAIChatModelId

typealias TogetherAIChatModelId = String

TogetherAICompletionModelId

typealias TogetherAICompletionModelId = String

TogetherAIEmbeddingModelId

typealias TogetherAIEmbeddingModelId = String

TogetherAIErrorData

typealias TogetherAIErrorData = JsonElement

TogetherAIImageModelId

typealias TogetherAIImageModelId = String

TogetherAIImageModelOptions

@Serializable

data class TogetherAIImageModelOptions(val steps: Int? = null, val guidance: Float? = null, val negativePrompt: String? = null, val disableSafetyChecker: Boolean? = null, val raw: Map<String, JsonElement> = emptyMap())

TogetherAIImageProviderOptions

typealias TogetherAIImageProviderOptions = TogetherAIImageModelOptions

TogetherAIProvider

interface TogetherAIProvider : Provider

TogetherAIProviderSettings

@Serializable

data class TogetherAIProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.together.xyz/v1", val headers: Map<String, String> = emptyMap())

TogetherAIRerankingModel

class TogetherAIRerankingModel(client: HttpClient, settings: TogetherAIProviderSettings, val modelId: TogetherAIRerankingModelId) : RerankingModel

TogetherAIRerankingModelId

typealias TogetherAIRerankingModelId = String

TogetherAIRerankingModelOptions

@Serializable

data class TogetherAIRerankingModelOptions(val rankFields: List<String>? = null)

TogetherAIRerankingOptions

typealias TogetherAIRerankingOptions = TogetherAIRerankingModelOptions

UrlContextMetadataSchema

typealias UrlContextMetadataSchema = JsonObject

UsageMetadataSchema

typealias UsageMetadataSchema = JsonObject

VercelChatModelId

typealias VercelChatModelId = String

VercelErrorData

typealias VercelErrorData = JsonElement

VercelProvider

interface VercelProvider : Provider

VercelProviderSettings

@Serializable

data class VercelProviderSettings(val apiKey: String? = null, val baseURL: String = "https://api.v0.dev/v1", val headers: Map<String, String> = emptyMap())

VoyageEmbeddingModelId

typealias VoyageEmbeddingModelId = String

VoyageEmbeddingModelOptions

@Serializable

data class VoyageEmbeddingModelOptions(val inputType: String? = null, val truncation: Boolean? = null, val outputDimension: Int? = null, val outputDtype: String? = null)

VoyageProvider

interface VoyageProvider : Provider

VoyageProviderSettings

@Serializable

data class VoyageProviderSettings(val baseURL: String = "https://api.voyageai.com/v1", val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

VoyageRerankingModelId

typealias VoyageRerankingModelId = String

VoyageRerankingModelOptions

@Serializable

data class VoyageRerankingModelOptions(val returnDocuments: Boolean? = null, val truncation: Boolean? = null)

XaiChatModelId

typealias XaiChatModelId = String

XaiErrorData

typealias XaiErrorData = JsonElement

XaiImageModelId

typealias XaiImageModelId = String

XaiImageModelOptions

@Serializable

data class XaiImageModelOptions(val aspect_ratio: String? = null, val output_format: String? = null, val sync_mode: Boolean? = null, val resolution: String? = null, val quality: String? = null, val user: String? = null)

XaiImageProviderOptions

typealias XaiImageProviderOptions = XaiImageModelOptions

XaiLanguageModelChatOptions

@Serializable

data class XaiLanguageModelChatOptions(val reasoningEffort: String? = null, val logprobs: Boolean? = null, val topLogprobs: Int? = null, val parallel_function_calling: Boolean? = null, val searchParameters: JsonElement? = null)

XaiLanguageModelResponsesOptions

@Serializable

data class XaiLanguageModelResponsesOptions(val reasoningEffort: String? = null, val reasoningSummary: String? = null)

XaiProvider

interface XaiProvider : Provider

XaiProviderOptions

typealias XaiProviderOptions = XaiLanguageModelChatOptions

XaiProviderSettings

@Serializable

data class XaiProviderSettings(val baseURL: String = "https://api.x.ai/v1", val apiKey: String? = null, val headers: Map<String, String> = emptyMap())

XaiResponsesModelId

typealias XaiResponsesModelId = String

XaiResponsesProviderOptions

typealias XaiResponsesProviderOptions = XaiLanguageModelResponsesOptions

XaiTools

data class XaiTools(val codeExecution: Tool<JsonElement, JsonElement, Any?> = codeExecution(), val fileSearch: Tool<JsonElement, JsonElement, Any?> = fileSearch(), val mcpServer: Tool<JsonElement, JsonElement, Any?> = mcpServer(), val viewImage: Tool<JsonElement, JsonElement, Any?> = viewImage(), val viewXVideo: Tool<JsonElement, JsonElement, Any?> = viewXVideo(), val webSearch: Tool<JsonElement, JsonElement, Any?> = webSearch(), val xSearch: Tool<JsonElement, JsonElement, Any?> = xSearch())

XaiVideoModelId

typealias XaiVideoModelId = String

XaiVideoModelOptions

@Serializable

data class XaiVideoModelOptions(val mode: String? = null, val videoUrl: String? = null, val referenceImageUrls: List<String>? = null, val pollIntervalMs: Long? = null, val pollTimeoutMs: Long? = null, val resolution: String? = null)

XaiVideoProviderOptions

typealias XaiVideoProviderOptions = XaiVideoModelOptions

Properties

alibaba

val alibaba: AlibabaProvider

ALIBABA_VERSION

const val ALIBABA_VERSION: String

AMAZON_BEDROCK_VERSION

const val AMAZON_BEDROCK_VERSION: String

anthropic

val anthropic: AnthropicProvider

ANTHROPIC_AWS_VERSION

const val ANTHROPIC_AWS_VERSION: String

ANTHROPIC_VERSION

const val ANTHROPIC_VERSION: String

anthropicAws

val anthropicAws: AnthropicAwsProvider

anthropicTools

val anthropicTools: AnthropicTools

assemblyai

val assemblyai: AssemblyAIProvider

ASSEMBLYAI_VERSION

const val ASSEMBLYAI_VERSION: String

azure

val azure: AzureOpenAIProvider

AZURE_VERSION

const val AZURE_VERSION: String

azureOpenaiTools

val azureOpenaiTools: AzureOpenAITools

baseten

val baseten: BasetenProvider

BASETEN_VERSION

const val BASETEN_VERSION: String

bedrock

val bedrock: AmazonBedrockProvider

bedrockAnthropic

val bedrockAnthropic: BedrockAnthropicProvider

bedrockMantle

val bedrockMantle: BedrockMantleProvider

BLACK_FOREST_LABS_VERSION

const val BLACK_FOREST_LABS_VERSION: String

blackForestLabs

val blackForestLabs: BlackForestLabsProvider

browserSearch

val browserSearch: Tool<JsonElement, JsonElement, Any?>

byteDance

val byteDance: ByteDanceProvider

BYTEDANCE_VERSION

const val BYTEDANCE_VERSION: String

cerebras

val cerebras: CerebrasProvider

CEREBRAS_VERSION

const val CEREBRAS_VERSION: String

cohere

val cohere: CohereProvider

COHERE_VERSION

const val COHERE_VERSION: String

deepgram

val deepgram: DeepgramProvider

DEEPGRAM_VERSION

const val DEEPGRAM_VERSION: String

deepinfra

val deepinfra: DeepInfraProvider

DEEPINFRA_VERSION

const val DEEPINFRA_VERSION: String

deepseek

val deepseek: DeepSeekProvider

DEEPSEEK_VERSION

const val DEEPSEEK_VERSION: String

elevenlabs

val elevenlabs: ElevenLabsProvider

ELEVENLABS_VERSION

const val ELEVENLABS_VERSION: String

fal

val fal: FalProvider

FAL_VERSION

const val FAL_VERSION: String

fireworks

val fireworks: FireworksProvider

FIREWORKS_VERSION

const val FIREWORKS_VERSION: String

gladia

val gladia: GladiaProvider

GLADIA_VERSION

const val GLADIA_VERSION: String

google

val google: GoogleGenerativeAIProvider

GOOGLE_VERSION

const val GOOGLE_VERSION: String

GOOGLE_VERTEX_VERSION

const val GOOGLE_VERTEX_VERSION: String

googleTools

val googleTools: GoogleTools

googleVertexXai

val googleVertexXai: GoogleVertexXaiProvider

groq

val groq: GroqProvider

GROQ_VERSION

const val GROQ_VERSION: String

huggingface

val huggingface: HuggingFaceProvider

HUGGINGFACE_VERSION

const val HUGGINGFACE_VERSION: String

hume

val hume: HumeProvider

HUME_VERSION

const val HUME_VERSION: String

klingai

val klingai: KlingAIProvider

KLINGAI_VERSION

const val KLINGAI_VERSION: String

lmnt

val lmnt: LMNTProvider

LMNT_VERSION

const val LMNT_VERSION: String

luma

val luma: LumaProvider

LUMA_VERSION

const val LUMA_VERSION: String

mistral

val mistral: MistralProvider

MISTRAL_VERSION

const val MISTRAL_VERSION: String

moonshotai

val moonshotai: MoonshotAIProvider

MOONSHOTAI_VERSION

const val MOONSHOTAI_VERSION: String

OPEN_RESPONSES_SUPPORTED_URLS

val OPEN_RESPONSES_SUPPORTED_URLS: Map<String, List<String>>

OPEN_RESPONSES_TOP_LOGPROBS_MAX

const val OPEN_RESPONSES_TOP_LOGPROBS_MAX: Int = 20

OPEN_RESPONSES_VERSION

const val OPEN_RESPONSES_VERSION: String

openai

val openai: OpenAIProvider

OPENAI_RESPONSES_SUPPORTED_URLS

val OPENAI_RESPONSES_SUPPORTED_URLS: Map<String, List<String>>

perplexity

val perplexity: PerplexityProvider

PERPLEXITY_VERSION

const val PERPLEXITY_VERSION: String

prodia

val prodia: ProdiaProvider

PRODIA_VERSION

const val PRODIA_VERSION: String

quiverai

val quiverai: QuiverAIProvider

QUIVERAI_VERSION

const val QUIVERAI_VERSION: String

replicate

val replicate: ReplicateProvider

REPLICATE_VERSION

const val REPLICATE_VERSION: String

revai

val revai: RevaiProvider

REVAI_VERSION

const val REVAI_VERSION: String

togetherai

val togetherai: TogetherAIProvider

TOGETHERAI_VERSION

const val TOGETHERAI_VERSION: String

vercel

val vercel: VercelProvider

VERCEL_VERSION

const val VERCEL_VERSION: String

VERSION

const val VERSION: String

vertex

val vertex: GoogleVertexProvider

vertexAnthropic

val vertexAnthropic: GoogleVertexAnthropicProvider

vertexMaas

val vertexMaas: GoogleVertexMaasProvider

voyage

val voyage: VoyageProvider

VOYAGE_VERSION

const val VOYAGE_VERSION: String

xai

val xai: XaiProvider

XAI_VERSION

const val XAI_VERSION: String

xaiTools

val xaiTools: XaiTools

Functions

codeExecution

fun codeExecution(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

createAlibaba

fun createAlibaba(client: HttpClient, settings: AlibabaProviderSettings = AlibabaProviderSettings()): AlibabaProvider

createAmazonBedrock

fun createAmazonBedrock(client: HttpClient, settings: AmazonBedrockProviderSettings = AmazonBedrockProviderSettings()): AmazonBedrockProvider

createAnthropic

fun createAnthropic(client: HttpClient, settings: AnthropicProviderSettings = AnthropicProviderSettings()): AnthropicProvider

createAnthropicAws

fun createAnthropicAws(client: HttpClient, settings: AnthropicAwsProviderSettings = AnthropicAwsProviderSettings()): AnthropicAwsProvider

createAssemblyAI

fun createAssemblyAI(client: HttpClient, settings: AssemblyAIProviderSettings = AssemblyAIProviderSettings()): AssemblyAIProvider

createAzure

fun createAzure(client: HttpClient, settings: AzureOpenAIProviderSettings = AzureOpenAIProviderSettings()): AzureOpenAIProvider

createBaseten

fun createBaseten(client: HttpClient, settings: BasetenProviderSettings = BasetenProviderSettings()): BasetenProvider

createBedrockAnthropic

fun createBedrockAnthropic(client: HttpClient, settings: BedrockAnthropicProviderSettings = BedrockAnthropicProviderSettings()): BedrockAnthropicProvider

createBedrockMantle

fun createBedrockMantle(client: HttpClient, settings: BedrockMantleProviderSettings = BedrockMantleProviderSettings()): BedrockMantleProvider

createBlackForestLabs

fun createBlackForestLabs(client: HttpClient, settings: BlackForestLabsProviderSettings = BlackForestLabsProviderSettings()): BlackForestLabsProvider

createByteDance

fun createByteDance(client: HttpClient, settings: ByteDanceProviderSettings = ByteDanceProviderSettings()): ByteDanceProvider

createCerebras

fun createCerebras(client: HttpClient, settings: CerebrasProviderSettings = CerebrasProviderSettings()): CerebrasProvider

createCohere

fun createCohere(client: HttpClient, settings: CohereProviderSettings = CohereProviderSettings()): CohereProvider

createDeepgram

fun createDeepgram(client: HttpClient, settings: DeepgramProviderSettings = DeepgramProviderSettings()): DeepgramProvider

createDeepInfra

fun createDeepInfra(client: HttpClient, settings: DeepInfraProviderSettings = DeepInfraProviderSettings()): DeepInfraProvider

createDeepSeek

fun createDeepSeek(client: HttpClient, settings: DeepSeekProviderSettings = DeepSeekProviderSettings()): DeepSeekProvider

createElevenLabs

fun createElevenLabs(client: HttpClient, settings: ElevenLabsProviderSettings = ElevenLabsProviderSettings()): ElevenLabsProvider

createFal

fun createFal(client: HttpClient, settings: FalProviderSettings = FalProviderSettings()): FalProvider

createFireworks

fun createFireworks(client: HttpClient, settings: FireworksProviderSettings = FireworksProviderSettings()): FireworksProvider

createGladia

fun createGladia(client: HttpClient, settings: GladiaProviderSettings = GladiaProviderSettings()): GladiaProvider

createGoogleGenerativeAI

fun createGoogleGenerativeAI(client: HttpClient, settings: GoogleGenerativeAIProviderSettings = GoogleGenerativeAIProviderSettings()): GoogleGenerativeAIProvider

createGoogleVertexXai

fun createGoogleVertexXai(client: HttpClient, settings: GoogleVertexXaiProviderSettings = GoogleVertexXaiProviderSettings()): GoogleVertexXaiProvider

createGroq

fun createGroq(client: HttpClient, settings: GroqProviderSettings = GroqProviderSettings()): GroqProvider

createHuggingFace

fun createHuggingFace(client: HttpClient, settings: HuggingFaceProviderSettings = HuggingFaceProviderSettings()): HuggingFaceProvider

createHume

fun createHume(client: HttpClient, settings: HumeProviderSettings = HumeProviderSettings()): HumeProvider

createKlingAI

fun createKlingAI(client: HttpClient, settings: KlingAIProviderSettings = KlingAIProviderSettings()): KlingAIProvider

createLMNT

fun createLMNT(client: HttpClient, settings: LMNTProviderSettings = LMNTProviderSettings()): LMNTProvider

createLuma

fun createLuma(client: HttpClient, settings: LumaProviderSettings = LumaProviderSettings()): LumaProvider

createMistral

fun createMistral(client: HttpClient, settings: MistralProviderSettings = MistralProviderSettings()): MistralProvider

createMoonshotAI

fun createMoonshotAI(client: HttpClient, settings: MoonshotAIProviderSettings = MoonshotAIProviderSettings()): MoonshotAIProvider

createOpenAI

fun createOpenAI(client: HttpClient, settings: OpenAIProviderSettings = OpenAIProviderSettings()): OpenAIProvider

createOpenAICompatible

fun createOpenAICompatible(client: HttpClient, settings: OpenAICompatibleProviderSettings, json: Json = aiSdkJson): OpenAICompatibleProvider

createOpenAICompatibleProvider

fun createOpenAICompatibleProvider(client: HttpClient, settings: OpenAICompatibleProviderSettings, json: Json = aiSdkJson): OpenAICompatibleProvider

createOpenAIProvider

fun createOpenAIProvider(client: HttpClient, settings: OpenAIProviderSettings = OpenAIProviderSettings()): OpenAIProvider

createOpenResponses

fun createOpenResponses(client: HttpClient, settings: OpenResponsesProviderSettings, json: Json = openResponsesJson): OpenResponsesProvider

createPerplexity

fun createPerplexity(client: HttpClient, settings: PerplexityProviderSettings = PerplexityProviderSettings()): PerplexityProvider

createProdia

fun createProdia(client: HttpClient, settings: ProdiaProviderSettings = ProdiaProviderSettings()): ProdiaProvider

createQuiverAI

fun createQuiverAI(client: HttpClient, settings: QuiverAIProviderSettings = QuiverAIProviderSettings()): QuiverAIProvider

createReplicate

fun createReplicate(client: HttpClient, settings: ReplicateProviderSettings = ReplicateProviderSettings()): ReplicateProvider

createRevai

fun createRevai(client: HttpClient, settings: RevaiProviderSettings = RevaiProviderSettings()): RevaiProvider

createTogetherAI

fun createTogetherAI(client: HttpClient, settings: TogetherAIProviderSettings = TogetherAIProviderSettings()): TogetherAIProvider

createVercel

fun createVercel(client: HttpClient, settings: VercelProviderSettings = VercelProviderSettings()): VercelProvider

createVertex

fun createVertex(client: HttpClient, settings: GoogleVertexProviderSettings = GoogleVertexProviderSettings()): GoogleVertexProvider

createVertexAnthropic

fun createVertexAnthropic(client: HttpClient, settings: GoogleVertexAnthropicProviderSettings = GoogleVertexAnthropicProviderSettings()): GoogleVertexAnthropicProvider

createVertexMaas

fun createVertexMaas(client: HttpClient, settings: GoogleVertexMaasProviderSettings = GoogleVertexMaasProviderSettings()): GoogleVertexMaasProvider

createVoyage

fun createVoyage(client: HttpClient, settings: VoyageProviderSettings = VoyageProviderSettings()): VoyageProvider

createXai

fun createXai(client: HttpClient, settings: XaiProviderSettings = XaiProviderSettings()): XaiProvider

fileSearch

fun fileSearch(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

forwardAnthropicContainerIdFromLastStep

fun forwardAnthropicContainerIdFromLastStep(steps: List<Map<String, JsonElement>>): Map<String, JsonElement>?

mcpServer

fun mcpServer(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

mockAudioSource

fun mockAudioSource(): AudioSource

mockLanguageModelTextOnly

fun mockLanguageModelTextOnly(text: String): MockLanguageModel

A model that just emits the given text once and finishes.

mockLanguageModelToolThenText

fun mockLanguageModelToolThenText(toolName: String, toolInput: JsonObject, finalText: String, toolCallId: String = "call_1"): MockLanguageModel

A model whose first call requests a tool, second call (after the tool result is appended) returns a final text response.

mockToolInput

fun mockToolInput(vararg pairs: Pair<String, String>): JsonObject

Convenience for a tool-call input expressed as JSON literal map.

openAIApplyPatch

fun openAIApplyPatch(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAICodeInterpreter

fun openAICodeInterpreter(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAIFileSearch

fun openAIFileSearch(args: JsonElement): Tool<JsonElement, JsonElement, Any?>

openAIImageGeneration

fun openAIImageGeneration(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAILocalShell

fun openAILocalShell(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAIMcp

fun openAIMcp(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAIShell

fun openAIShell(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAIToolSearch

fun openAIToolSearch(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAIWebSearch

fun openAIWebSearch(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

openAIWebSearchPreview

fun openAIWebSearchPreview(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

viewImage

fun viewImage(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

viewXVideo

fun viewXVideo(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

webSearch

fun webSearch(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>

xSearch

fun xSearch(args: JsonElement = JsonObject(emptyMap())): Tool<JsonElement, JsonElement, Any?>